/*
Package hyphenation is a quick and dirty implementation of a hyphenation algorithm.

(TODO: make more time and space efficient).

Package for an algorithm to hyphenate words. It is based on an algorithm
described by Frank Liang (F.M.Liang http://www.tug.org/docs/liang/). It loads
a pattern file (available with the TeX distribution) and builds a trie
structure, carrying an array of positions at every 'leaf'.

The trie package I'm using here is a very naive implementation and should
be replaced by a more sophisticated one
(e.g., https://github.com/siongui/go-succinct-data-structure-trie).
Resulting from the API of the trie, the implementation of the pattern
application algorithm is bad. TODO: improve time complexity of pattern
application.

Further Reading

  https://www.microsoft.com/en-us/Typography/OpenTypeSpecification.aspx
  https://nedbatchelder.com/code/modules/hyphenate.html   (Python implementation)
  http://www.mnn.ch/hyph/hyphenation2.html  / https://github.com/mnater/hyphenator

----------------------------------------------------------------------

BSD License

Copyright (c) 2017-21, Norbert Pillmayer

All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

3. Neither the name of this software nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
package hyphenation
